04. Project Instructions

Running the Kidnapped Vehicle project.

This workspace is designed to be a simple, easy to use environment in which you can code and run the
Kidnapped Vehicle project. If you prefer to run the project on your computer, you can clone/fork the repository in your local setup.

For tips on workspace use, please review the Workspaces lesson from Term 1.

Accessing and using the workspace:

  • Navigate to the workspace node. If you need to test your solution, enable the GPU - otherwise, you won't be able to run the simulator. Remember to turn it off when you code your solution so that you don't run out of GPU hours.
  • Navigate to the repository CarND-Kidnapped-Vehicle-Project using menu on the left.
  • Complete the TODO in particle_filter.cpp and particle_filter.h using the text editor in the workspace.
  • Navigate to the project repository in the terminal.

The main program can be built and run by doing the following from the project top directory:

  1. In the terminal execute ./clean.sh to make sure you don't have old files in the directory.
  2. In the terminal execute ./build.sh to build the project.
  3. In the terminal execute ./run.sh to execute your solution.

All Project instructions can be found in the README.md (you can view the instruction in an easy-to-read format by visiting the previous link).

Click on the "Simulator" button in the bottom of the Udacity workspace, which will open a new virtual desktop. You should see a "Simulator" icon on the virtual desktop. Double-click the "Simulator" icon in that desktop to start the simulator.

**Important: ** You need to open a terminal before attempting to run the simulator.

Using GitHub and Creating Effective READMEs

If you are unfamiliar with GitHub , Udacity has a brief GitHub tutorial to get you started. Udacity also provides a more detailed free course on git and GitHub .

To learn about README files and Markdown, Udacity provides a free course on READMEs , as well.

GitHub also provides a tutorial about creating Markdown files.

## Commit to GitHub
Students are highly encouraged to commit their project to a GitHub repo. To do this, you must change the upstream of the current repository and add your credentials. We have supplied a bash script to help you do this. Please open up a terminal, navigate to the project repository, and enter: ./set_git.sh , then follow the prompts. This will set the upstream remote to your own repository and add your email and username to the git configuration. At this time we are not configuring passwords, so you will need to enter your username and password for each push. Since credentials are not persistent, it will be necessary to run this script each time you open, refresh, or reset the workspace.

Submitting your project

When you are confident that your particle filter is working correctly, submit your project using Github or by uploading a zipped archive of your project files. Or if using **workspaces ** click on the button on the right bottom and follow the instructions. You can check out the rubric here prior to submitting.

Project Support

If you are stuck or having difficulties with the project, don't lose hope! Remember to talk to your mentors and fellow students in your Study Group, as well as ask (and answer!) questions on Knowledge tagged with the project name. We also have a previously recorded project Q&A that you can watch here !

Next Concept